#!/usr/bin/env python
# coding: utf-8

# # 实验名称：波士顿房价预测模型
# 
# # 1. 实验简介：
# 
# 本节课我们将尝试使用飞桨构建房价预测模型，通过这个项目，大家可以掌握飞桨框架的基本用法。
# 
# # 2. 实验过程：
# 
# 如何使用飞桨构建房价预测模型呢？其过程如下：
# 
# <br></br>
# <center><img src="https://ai-studio-static-online.cdn.bcebos.com/1ffe7bba8205457db1f3df637686c961403eaa84bfec4ebf822cefdea2e4a001" width="800" hegiht="" ></center>
# <center><br>图1：使用飞桨框架构建神经网络过程</br></center>
# <br></br>
# 
# # 3.导入相关库
# 
# 在数据处理之前，需要先加载飞桨框架的相关类库。

# In[35]:


#加载飞桨、Numpy和相关类库
import paddle
import paddle.fluid as fluid
import paddle.fluid.dygraph as dygraph
from paddle.fluid.dygraph import Linear
import numpy as np
import os
import random


# 代码中参数含义如下：
# 
# * paddle/fluid：飞桨的主库，目前大部分的实用函数均在paddle.fluid包内。
# * dygraph：动态图的类库。
# * Linear：神经网络的全连接层函数，即包含所有输入权重相加和激活函数的基本神经元结构。在房价预测任务中，使用只有一层的神经网络（全连接层）来实现线性回归模型。
# <br></br>
# 
# ------
# 
# **说明：**
# 
# 飞桨支持两种深度学习建模编写方式，更方便调试的动态图模式和性能更好并便于部署的静态图模式。
# 
# * 静态图模式（声明式编程范式，类比C++）：先编译后执行的方式。用户需预先定义完整的网络结构，再对网络结构进行编译优化后，才能执行获得计算结果。
# * 动态图模式（命令式编程范式，类比Python）：解析式的执行方式。用户无需预先定义完整的网络结构，每写一行网络代码，即可同时获得计算结果。
# 
# 为了学习模型和调试的方便，本教程均使用动态图模式编写模型。在后续的资深教程中，会详细介绍静态图以及将动态图模型转成静态图的方法。仅在部分场景下需要模型转换，并且是相对容易的。
# 
# ------
# 
# 
# 

# ## 4. 数据处理
# ### 4.1 数据集介绍
# 
# 波士顿房价预测是一个经典的机器学习任务。波士顿地区的房价是由诸多因素影响的。该数据集统计了13种可能影响房价的因素和该类型房屋的均价，期望构建一个基于13个因素进行房价预测的模型，如 图2 所示。 
# <br></br>
# <center><img src="https://ai-studio-static-online.cdn.bcebos.com/52eba82f42d34f6480fe2ab01db3b594f17df96ea7d84802bc524649cb4213a0" width="500" hegiht="" ></center>
# <center><br>图2：波士顿房价预测数据集</br></center>
# <br></br>
# 对于预测问题，可以根据预测输出的类型是连续的实数值，还是离散的标签，区分为回归任务和分类任务。因为房价是一个连续值，所以房价预测显然是一个回归任务。
# 
# ### 4.2 导入数据集
# 我们定义一个load_data() 方法，用来加载数据。数据处理的代码不依赖框架实现，详细过程请看下面注释。

# In[36]:


def load_data():
    # 从文件导入数据
    datafile = './work/housing.data'
    data = np.fromfile(datafile, sep=' ')

    # 每条数据包括14项，其中前面13项是影响因素，第14项是相应的房屋价格中位数
    feature_names = [ 'CRIM', 'ZN', 'INDUS', 'CHAS', 'NOX', 'RM', 'AGE',                       'DIS', 'RAD', 'TAX', 'PTRATIO', 'B', 'LSTAT', 'MEDV' ]
    feature_num = len(feature_names)

    # 将原始数据进行Reshape，变成[N, 14]这样的形状
    data = data.reshape([data.shape[0] // feature_num, feature_num])

    # 将原数据集拆分成训练集和测试集
    # 这里使用80%的数据做训练，20%的数据做测试
    # 测试集和训练集必须是没有交集的
    ratio = 0.8
    offset = int(data.shape[0] * ratio)
    training_data = data[:offset]

    # 计算train数据集的最大值，最小值，平均值
    maximums, minimums, avgs = training_data.max(axis=0), training_data.min(axis=0),                                  training_data.sum(axis=0) / training_data.shape[0]
    
    # 记录数据的归一化参数，在预测时对数据做归一化
    global max_values
    global min_values
    global avg_values
    max_values = maximums
    min_values = minimums
    avg_values = avgs

    # 对数据进行归一化处理
    for i in range(feature_num):
        #print(maximums[i], minimums[i], avgs[i])
        data[:, i] = (data[:, i] - avgs[i]) / (maximums[i] - minimums[i])

    # 训练集和测试集的划分比例
    #ratio = 0.8
    #offset = int(data.shape[0] * ratio)
    training_data = data[:offset]
    test_data = data[offset:]
    return training_data, test_data


# ## 5.模型设计
# ### 5.1 模型设计理论
# 模型设计是深度学习模型关键要素之一，也称为网络结构设计，相当于模型的假设空间，即实现模型“前向计算”（从输入到输出）的过程。
# 如果将输入特征和输出预测值均以向量表示，输入特征x有13个分量，y有1个分量，那么参数权重的形状（shape）是一个13维的向量。
# 假设房价和各影响因素之间能够用线性关系来描述：
# 
# $$y = {\sum_{j=1}^Mx_j w_j} + b$$
# 
# 模型的求解即是通过数据拟合出每个$w_j$和$b$。其中，$w_j$和$b$分别表示该线性模型的权重和偏置。一维情况下，$w_j$ 和 $b$ 是直线的斜率和截距。
# 
# 线性回归模型使用均方误差作为损失函数（Loss），用以衡量预测房价和真实房价的差异，公式如下：
# 
# $$MSE = \frac{1}{n} \sum_{i=1}^n(\hat{Y_i} - {Y_i})^{2}$$
# 
# 
# 神经网络的标准结构中每个神经元由加权和与非线性变换构成，然后将多个神经元分层的摆放并连接形成神经网络。线性回归模型可以认为是神经网络模型的一种极简特例，是一个只有加权和、没有非线性变换的神经元（无需形成网络），如 图3 所示。
# <br></br>
# <center><img src="https://ai-studio-static-online.cdn.bcebos.com/ac1f84e0c10e4979bebad9ebc1f4a870c76a4f5c0af543beb21a607efebfb576" width="400" hegiht="" ></center>
# <center><br>图3：网络结构</br></center>
# <br></br>
# 
# 
# ### 5.2 用飞桨实现模型设计
# 本例中模型定义的实质是定义线性回归的网络结构，飞桨建议通过创建Python类的方式完成模型网络的定义，即定义``init``函数和``forward``函数。``forward``函数是框架指定实现前向计算逻辑的函数，程序在调用模型实例时会自动执行forward方法。在``forward``函数中使用的网络层需要在``init``函数中声明。
# 
# 实现过程分如下两步：
# 
# 1. **定义init函数**：在类的初始化函数中声明每一层网络的实现函数。在房价预测模型中，只需要定义一层全连接层FC。
# 1. **定义forward函数**：构建神经网络结构，实现前向计算过程，并返回预测结果，在本任务中返回的是房价预测结果。
# 
# ------
# **说明：**
# 
# ``name_scope``变量用于调试模型时追踪多个模型的变量，在此忽略即可，飞桨1.7及之后版本不强制用户设置``name_scope``。
# 
# ------

# In[37]:


class Regressor(fluid.dygraph.Layer):
    def __init__(self, name_scope):
        super().__init__(name_scope)
        name_scope = self.full_name()
        # 定义一层全连接层，输出维度是1，激活函数为None，即不使用激活函数
        self.fc = Linear(input_dim=13, output_dim=1, act=None)
    
    # 网络的前向计算函数
    def forward(self, inputs):
        x = self.fc(inputs)
        return x


# ## 6.训练配置
# 
# 训练配置过程包含四步，如 **图4** 所示：
# <center><img src="https://ai-studio-static-online.cdn.bcebos.com/d3811185a5f646b49c398a9fdc8be3c72794b9b23d9e4d71af92361e0bb5e608" width="700" hegiht="" ></center>
# <center><br>图4：训练配置流程示意图</br></center>
# <br></br>
# 
# 1. 以``grard``函数指定运行训练的机器资源，表明在``with``作用域下的程序均执行在本机的CPU资源上。``dygraph.guard``表示在``with``作用域下的程序会以飞桨动态图的模式执行（实时执行）。
# 1. 声明定义好的回归模型Regressor实例，并将模型的状态设置为训练。
# 1. 使用load_data函数加载训练数据和测试数据。
# 1. 设置优化算法和学习率，优化算法采用随机梯度下降[SGD](https://www.paddlepaddle.org.cn/documentation/docs/zh/api_cn/optimizer_cn/SGDOptimizer_cn.html#cn-api-fluid-optimizer-sgdoptimizer)，学习率设置为0.01。
# 
# 训练配置代码如下所示：

# In[38]:


# 定义飞桨动态图的工作环境
with fluid.dygraph.guard():
    # 声明定义好的线性回归模型
    model = Regressor("Regressor")
    # 开启模型训练模式
    model.train()
    # 加载数据
    training_data, test_data = load_data()
    # 定义优化算法，这里使用随机梯度下降-SGD
    # 学习率设置为0.01
    opt = fluid.optimizer.SGD(learning_rate=0.01, parameter_list=model.parameters())


# ------
# 
# **说明：**
# 
# 1. 默认本案例运行模型训练的机器资源为CPU。
# 1. 模型实例有两种状态：训练状态``（.train()）``和预测状态``(.eval())``。训练时要执行正向计算和反向传播梯度两个过程，而预测时只需要执行正向计算。为模型指定运行状态，有两点原因：
# 
# （1）部分高级的算子（例如Drop out和Batch Normalization，在计算机视觉的章节会详细介绍）在两个状态执行的逻辑不同。
# 
# （2）从性能和存储空间的考虑，预测状态时更节省内存，性能更好。
# 
# 3. 在上述代码中可以发现声明模型、定义优化器等操作都在``with``创建的 [fluid.dygraph.guard()](https://www.paddlepaddle.org.cn/documentation/docs/zh/api_cn/dygraph_cn/guard_cn.html#guard)上下文环境中进行，可以理解为``with fluid.dygraph.guard()``创建了飞桨动态图的工作环境，在该环境下完成模型声明、数据转换及模型训练等操作。
# ------
# 
# 发现了吗？如果我们使用Python实现神经网络模型，仅在编写梯度下降时就要写出大量代码，而使用飞桨框架只需要定义SDG就可以实现优化器设置，大大简化了这个过程。

# ## 7.训练过程
# 
# 训练过程采用二层循环嵌套方式：
# 
# - **内层循环：** 负责整个数据集的一次遍历，采用分批次方式（batch）。假设数据集样本数量为1000，一个批次有10个样本，则遍历一次数据集的批次数量是1000/10=100，即内层循环需要执行100次。
# 
#         for iter_id, mini_batch in enumerate(mini_batches):
# 
# - **外层循环：** 定义遍历数据集的次数，通过参数EPOCH_NUM设置。
# 
#         for epoch_id in range(EPOCH_NUM):
# 
# ------
# **说明**:
# 
# batch的取值会影响模型训练效果。batch过大，会增大内存消耗和计算时间，且效果并不会明显提升；batch过小，每个batch的样本数据将没有统计意义。由于房价预测模型的训练数据集较小，我们将batch为设置10。
# 
# ------
# 
# 每次内层循环都需要执行如下四个步骤，如 **图5** 所示。
# <center><img src="https://ai-studio-static-online.cdn.bcebos.com/b1dfc9ec1495486b9fdbecb02ad25a1d0fe64fcf847d4df8839a55c41684ef33" width="700" hegiht="" ></center>
# <center><br>图5：内循环计算过程</br></center>
# <br></br>
# 
# 1. 数据准备：将一个批次的数据转变成np.array和内置格式。
# 2. 前向计算：将一个批次的样本数据灌入网络中，计算输出结果。
# 3. 计算损失函数：以前向计算结果和真实房价作为输入，通过损失函数``square_error_cost``计算出损失函数值（Loss），API可参考[square_error_cost](https://www.paddlepaddle.org.cn/documentation/docs/zh/api_cn/layers_cn/square_error_cost_cn.html#square-error-cost/)。飞桨所有的API接口都有完整的说明和使用案例，在后续的资深教程中我们会详细介绍API的查阅方法。
# 4. 反向传播：执行梯度反向传播``backward``函数，即从后到前逐层计算每一层的梯度，并根据设置的优化算法更新参数``opt.minimize``。

# In[39]:


with dygraph.guard(fluid.CPUPlace()):
    EPOCH_NUM = 12   # 设置外层循环次数
    BATCH_SIZE = 11  # 设置batch大小
    
    # 定义外层循环
    for epoch_id in range(EPOCH_NUM):
        # 在每轮迭代开始之前，将训练数据的顺序随机的打乱
        np.random.shuffle(training_data)
        # 将训练数据进行拆分，每个batch包含10条数据
        mini_batches = [training_data[k:k+BATCH_SIZE] for k in range(0, len(training_data), BATCH_SIZE)]
        # 定义内层循环
        for iter_id, mini_batch in enumerate(mini_batches):
            x = np.array(mini_batch[:, :-1]).astype('float32') # 获得当前批次训练数据
            y = np.array(mini_batch[:, -1:]).astype('float32') # 获得当前批次训练标签（真实房价）
            # 将numpy数据转为飞桨动态图variable形式
            house_features = dygraph.to_variable(x)
            prices = dygraph.to_variable(y)
            
            # 前向计算
            predicts = model(house_features)
            
            # 计算损失
            loss = fluid.layers.square_error_cost(predicts, label=prices)
            avg_loss = fluid.layers.mean(loss)
            if iter_id%20==0:
                print("epoch: {}, iter: {}, loss is: {}".format(epoch_id, iter_id, avg_loss.numpy()))
            
            # 反向传播
            avg_loss.backward()
            # 最小化loss,更新参数
            opt.minimize(avg_loss)
            # 清除梯度
            model.clear_gradients()
    # 保存模型
    fluid.save_dygraph(model.state_dict(), 'LR_model')


# 这个实现过程令人惊喜，前向计算、计算损失和反向传播梯度，每个操作居然只有1-2行代码即可实现！我们再也不用一点点的实现模型训练的细节，这就是使用飞桨框架的威力！

# ## 8.保存并测试模型
# 
# ### 保存模型
# 
# 将模型当前的参数数据``model.state_dict()``保存到文件中（通过参数指定保存的文件名 LR_model），以备预测或校验的程序调用，代码如下所示。

# In[40]:


# 定义飞桨动态图工作环境
with fluid.dygraph.guard():
    # 保存模型参数，文件名为LR_model
    fluid.save_dygraph(model.state_dict(), 'LR_model')
    print("模型保存成功，模型参数保存在LR_model中")
    


# 理论而言，直接使用模型实例即可完成预测，而本次实验中预测的方式为什么是先保存模型，再加载模型呢？这是因为在实际应用中，训练模型和使用模型往往是不同的场景。模型训练通常使用大量的线下服务器（不对外向企业的客户/用户提供在线服务），而模型预测则通常使用线上提供预测服务的服务器，或者将已经完成的预测模型嵌入手机或其他终端设备中使用。
# 飞桨的愿景是用户只需要了解模型的逻辑概念，不需要关心实现细节，就能搭建强大的模型。
# 
# ### 测试模型
# 
# 下面我们选择一条数据样本，测试下模型的预测效果。测试过程和在应用场景中使用模型的过程一致，主要可分成如下三个步骤：
# 
# 1. 配置模型预测的机器资源。  
#     本案例默认使用本机，因此无需写代码指定。  
# 2. 将训练好的模型参数加载到模型实例中。  
#     由两个语句完成，第一句是从文件中读取模型参数；第二句是将参数内容加载到模型。  
#     加载完毕后，需要将模型的状态调整为``evalueation``（校验）。上文中提到，训练状态的模型需要同时支持前向计算和反向传导梯度，模型的实现较为臃肿，而校验和预测状态的模型只需要支持前向计算，模型的实现更加简单，性能更好。
# 3. 将待预测的样本特征输入到模型中，打印输出的预测结果。
# 
# 通过``load_one_example``函数实现从数据集中抽一条样本作为测试样本，具体实现代码如下所示。

# In[41]:


def load_one_example(data_dir):
    f = open(data_dir, 'r')
    datas = f.readlines()
    # 选择倒数第10条数据用于测试
    tmp = datas[-10]
    tmp = tmp.strip().split()
    one_data = [float(v) for v in tmp]

    # 对数据进行归一化处理
    for i in range(len(one_data)-1):
        one_data[i] = (one_data[i] - avg_values[i]) / (max_values[i] - min_values[i])

    data = np.reshape(np.array(one_data[:-1]), [1, -1]).astype(np.float32)
    label = one_data[-1]
    return data, label


# 将数据送给网络完成预测

# In[42]:



with dygraph.guard():
    # 参数为保存模型参数的文件地址
    model_dict, _ = fluid.load_dygraph('LR_model')
    model.load_dict(model_dict)
    model.eval()

    # 参数为数据集的文件地址
    test_data, label = load_one_example('./work/housing.data')
    # 将数据转为动态图的variable格式
    test_data = dygraph.to_variable(test_data)
    results = model(test_data)

    # 对结果做反归一化处理
    results = results * (max_values[-1] - min_values[-1]) + avg_values[-1]
    print("Inference result is {}, the corresponding label is {}".format(results.numpy(), label))


# 
# # 9.实验小结
# 
# 通过比较“模型预测值”和“真实房价”可见，模型的预测效果与真实房价接近。房价预测仅是一个最简单的模型，使用飞桨编写均可事半功倍。那么对于工业实践中更复杂的模型，使用飞桨节约的成本是不可估量的。同时飞桨针对很多应用场景和机器资源做了性能优化。
# 
